18.4 Die Zwischenablage 

In der .NET-Klassenbibliothek wird die Zwischenablage durch die Klasse Clipboard beschrieben. Die Klasse enthält keine öffentlichen Konstruktoren und kann demnach nicht instanziiert werden. Verglichen mit .NET 1.0/1.1 ist die Klasse um zahlreiche statische Methoden erweitert worden, die das Programmieren der Zwischenablage komfortabler und einfacher machen.

18.4.1 Speichern und Abrufen von Daten aus der Zwischenablage 

Die beiden allgemeinsten Methoden der Klasse Clipboard sind GetDataObject und SetDataObject, die den Datenaustausch in einem nicht festgeschriebenen Format erlauben. GetDataObject liest den Inhalt der Zwischenablage aus, die mehrfach überladene Methode SetDataObject schreibt die Daten hinein.

Das Speichern von Daten in der Zwischenablage mit »SetDataObject«

Wollen Sie eine Zeichenfolge in die Zwischenablage schreiben, übergeben Sie diese einfach der SetDataObject-Methode:

Da der Parameter vom Typ object ist, beschränkt sich die Übergabe aber nicht nur auf Zeichenfolgen. Sie können beliebige Objekte ablegen, beispielsweise auch die Referenz auf eine Bitmap:

Ein wiederholter Aufruf von SetDataObject hat zur Folge, dass der aktuelle Inhalt der Zwischenablage durch einen neuen überschrieben wird.

Der optionale boolesche Parameter der überladenen Methode SetDataObject gibt an, ob die Daten nach dem Beenden der Anwendung in der Zwischenablage bleiben sollen (true) oder nicht (false). Die Standardvorgabe ist false. Das hat jedoch auch noch eine anderweitige Konsequenz. Übergeben Sie nämlich dem zweiten Parameter true, enthält die Zwischenablage eine Kopie des Objekts. Die Folge davon ist, dass bei einer Änderung des Objekts der Inhalt der Zwischenablage unberührt bleibt.

Mit

wird die Referenz auf das Objekt obj in die Zwischenablage geschrieben. Änderungen am Objekt wirken sich dann auch auf die Zwischenablage aus.

Das Abrufen von Daten aus der Zwischenablage mit »GetDataObject«

Etwas komplexer ist das Abrufen der in der Zwischenablage befindlichen Daten. Das wird bereits klar, wenn Sie sich die Definition der Methode GetDataObject ansehen: Der Rückgabewert liefert ein Objekt, das die Schnittstelle IDataObject implementiert. Über die Methoden der Schnittstelle können weitere Informationen abgerufen werden.

Nehmen wir an, dass wir uns mit

den Inhalt aus der Zwischenablage holen. Auf die Referenz myData vom Typ der Schnittstelle IDataObject können wir vier Methoden aufrufen, die alle überladen sind. In Tabelle 18.2 sind die Methoden aufgeführt und die Verhaltensweisen beschrieben.

Betrachten wir den einfachsten und den in der Praxis vermutlich auch am häufigsten auftretenden Fall, dass in der Zwischenablage eine Zeichenfolge abgelegt ist, die abgerufen werden soll. Dazu sind zwei Anweisungen notwendig:

Mit der ersten Anweisung besorgen wir uns die Referenz auf ein Objekt vom Typ IDataObject und rufen darauf in der zweiten Anweisung die Methode GetData auf, der wir zur Identifizierung den Datentyp mit typeof übergeben. Damit können die Daten im richtigen Format ausgelesen werden. Den Wert, den uns GetData liefert, müssen wir noch in den entsprechenden Datentyp konvertieren.

Die Definition der im Codefragment benutzten GetData-Methode lautet:

Es gibt noch zwei weitere Überladungen, die anstelle der Type-Referenz eine Zeichenfolge entgegennehmen:

Damit ist es auch möglich, sich den Inhalt der Zwischenablage mit

textBox1.Text = (string)myData.GetData("System.String");

zu besorgen. Dabei gehen wir davon aus, dass die Daten auch als Zeichenfolge interpretierbar sind. Liegt ein anderes Datenformat vor, kann mit dem booleschen Parameter versucht werden, in das angegebene Format zu konvertieren. Dazu wird dem booleschen Parameter true übergeben.

Wollen Sie ermitteln, ob die Zwischenablage Daten enthält, die von Ihrer Anwendung verarbeitet werden können, muss die Verwertbarkeit überprüft werden. Dazu dient die Methode GetDataPresent.

Der Aufruf von

gibt beispielsweise true zurück, wenn die Zwischenablage Daten im string-Format enthält.

GetDataPresent eignet sich wegen des booleschen Rückgabewerts insbesondere als Bedingungsausdruck in eine if-Anweisung.

Sie können das Format der Daten abfragen, indem Sie eine Type-Referenz oder eine Zeichenfolge übergeben. Beispielsweise sind die beiden folgenden Ausdrücke gleichwertig:

Eine dritte Variante besteht darin, eine der statischen Eigenschaften der Klasse DataFormats zu übergeben, welche die von .NET unterstützten Zwischenablageformate als Zeichenfolgen zurückgeben. Mit

können Sie beispielsweise zuerst den Inhalt der Zwischenablage daraufhin untersuchen, ob er im Textformat vorliegt, und sich diesen anschließend in einem Meldungsfenster ausgeben lassen.

In der folgenden Tabelle finden Sie eine Auswahl der statischen Felder der Klasse DataFormats, die zum Namespace System.Windows.Forms gehört.

18.4.2 Andere Methoden, um Daten in die Zwischenablage zu schreiben und abzurufen 

GetDataObject und SetDataObject sind hinsichtlich des Datentyps sehr allgemein gehalten. Mehrere SetXxx-Methoden gestatten es, Daten eines bestimmten Formats in die Zwischenablage zu schreiben. Mit den analogen Methoden GetXxx kann der Inhalt der Zwischenablage ausgelesen werden. Ist das Datenformat nicht bekannt, können Sie dieses mit ContainsXxx-Methoden prüfen.

Der Einsatz der Methoden ist ausgesprochen simpel. Legen Sie darauf Wert, die Zwischenablage nur dann auszuwerten, wenn sie ein bestimmtes Datenformat beherbergt, fragen Sie das mit einer der ContainsXxx-Methoden ab. Ist das Ergebnis positiv, also true, rufen Sie die Daten mit der entsprechenden GetXxx-Methode ab.

18.4.3 Mehrere Datenformate in der Zwischenablage 

Normalerweise kann in der Zwischenablage immer nur ein Element gleichzeitig gespeichert werden. Dazu verwenden Sie die Methode SetXxx. Es ist allerdings möglich, ein bestimmtes Element in mehreren Formaten oder mehrere Elemente unterschiedlicher Formate in die Zwischenablage zu kopieren. Der Weg dazu führt über ein Objekt vom Typ DataObject. Dieser Typ, den man als Container für Elemente unterschiedlicher Formate ansehen kann, implementiert die IDataObject-Schnittstelle. Damit werden auch alle Methoden dieser Schnittstelle unterstützt, von denen für uns SetData von besonderem Interesse ist.

SetData speichert Daten in einem bestimmten Format im DataObject-Objekt. Dazu stehen mehrere Überladungen zur Verfügung.

Dem string-Parameter können Sie auch in diesem Fall eine Konstante der Klasse DataFormats übergeben.

Der Einsatz der Methode ist sehr einfach. Zuerst erzeugen Sie ein DataObject-Objekt und rufen auf dessen Referenz die Methode SetData auf, der Sie jeweils Elemente unterschiedlichen Formats übergeben. Damit befindet sich der Inhalt natürlich noch nicht in der Zwischenablage, denn dazu ist der Aufruf der Methode SetDataObject der Clipboard-Klasse zuständig, der das DataObject-Objekt übergeben wird.

Sollen mehrere unterschiedliche Formate der Zwischenablage übergeben werden, muss SetData mehrfach aufgerufen werden. Sehen wir uns dazu ein Beispiel an, bei dem der Zwischenablage sowohl ein Bitmap als auch eine Zeichenfolge übergeben wird.

Im Konstruktor der Form wird nach der Initialisierungsroutine programmatisch ein Bitmap in weißer Hintergrundfarbe und mit zwei Diagonalen erzeugt. Das Bitmap wird dem DataObject-Objekt übergeben, zusätzlich auch noch eine Zeichenfolge. Zum Schluss wird das DataObject-Objekt in die Zwischenablage geschrieben.

Die Form enthält neben einer Schaltfläche eine Picturebox und eine Textbox. Wird auf die Schaltfläche geklickt, wird der Inhalt der Zwischenablage einer Typuntersuchung unterzogen mit dem Ergebnis, dass das Bitmap in der Picturebox angezeigt wird und die Zeichenfolge in der Textbox (siehe Abbildung 18.9).

Hier klicken, um das Bild zu vergrößern

Abbildung 18.9   Ausgabe des Beispielprogramms »DataObjectDemo«

Schließen Sie die Anwendung, geht der Inhalt der Zwischenablage verloren. Wollen Sie, dass beispielsweise das Bitmap auch danach noch von einer anderen Anwendung wie MS Paint aus der Zwischenablage geholt werden kann, muss das DataObject-Object mit

der Zwischenablage übergeben werden.

18.4.4 Eigene Datenformate in die Zwischenablage schreiben 

Die Klasse DataFormats definiert eine Reihe von Formaten. Sie sind aber nicht ausschließlich an diese Liste gebunden, sondern können auch eigene Datentypen in die Zwischenablage kopieren. Dabei kommt die dreiparametrige Variante der Methode SetData zum Einsatz. Der erste Parameter empfängt den Namen des neuen Datenformats, der boolesche Parameter gibt Auskunft darüber, ob die Konvertierung in ein anderes Format zulässig ist, und dem dritten Parameter werden die zu kopierenden Daten übergeben.

Nehmen wir an, es wäre der Typ ClassA wie folgt definiert:

Beachten Sie, dass Typen, welche die Fähigkeit besitzen sollen, in die Zwischenablage kopiert zu werden, das Attribut Serializable aufweisen müssen.

Mit dem folgenden Code können wir ein Objekt des benutzerdefinierten Typs ClassA in die Zwischenablage kopieren:

Dem SetDataObject-Aufruf übergeben wir true. Daher kann auch nach dem Beenden der aktuellen Anwendung eine andere Anwendung die Daten auswerten – vorausgesetzt, der Anwendung ist der Typ ClassA bekannt.

Die Daten aus der Zwischenablage zu lesen, ist sehr einfach:

Das Leeren der Zwischenablage erfolgt mit dem Aufruf der Methode Clear:

18.4.5 Beispielprogramm – das Menü »Bearbeiten« 

Kommen wir nun zum Ausgangspunkt zurück, der dazu führte, dass wir uns mit der Programmierung der Zwischenablage beschäftigt haben. Wir wollten einer Textbox ein Kontextmenü bereitstellen, in dem die Menüelemente Ausschneiden, Kopieren und Einfügen implementiert sind. Dazu ergänzen wir das in Abschnitt 18.2.6 begonnene Beispielprogramm, in dem wir auch noch nicht die gleichlautenden Untermenüs von Bearbeiten codiert haben.

Der Konstruktor ist um eine Anweisung ergänzt, welche die Zwischenablage beim Start der Anwendung leert. Das ist keine Notwendigkeit, sondern dient nur dazu, das Verhalten des Menüelements Einfügen besser verfolgen zu können.

Sehen wir uns nun den Ereignishandler an, der markierten Text aus einer Textbox in die Zwischenablage schreibt.

Nur eine, wenn auch ausgesprochen lange Anweisung ist dazu da, nämlich der Aufruf der Methode SetText. Bevor der Methode aber die markierte Zeichenfolge übergeben werden kann, ist eine zweimalige Konvertierung notwendig. Hintergrund dafür ist, dass der Arbeitsbereich der Form vollständig durch einen anderen Container in Anspruch genommen wird, nämlich das ToolStripContainer-Objekt, in dem sich sämtliche Controls der Form versammeln, auch die beiden Textboxen.

Der einfache Aufruf von

liefert dann nicht, wie zunächst zu erwarten wäre, die Referenz auf die Textbox, die offensichtlich aktiv ist, sondern die Referenz auf das ToolStripContainer-Objekt. Da wir über dieses Objekt an die Textbox gelangen wollen, ist die erste Konvertierung notwendig:

Nun haben wir die gewünschte Referenz auf den ToolStripContainer, der als Containerelement seinerseits selbst die Eigenschaft ActiveControl aufweist. Da sich im Container nur zwei Textboxen befinden, können wir hier bedenkenlos in den Typ TextBox konvertieren.

Jetzt stehen uns alle Methoden und Eigenschaften einer Textbox zur Verfügung, von denen SelectedText die markierte Zeichenfolge liefert.

Eine ähnlich aufwändige Konvertierung ist auch zum Ausschneiden des markierten Textes notwendig, der anschließend mit SetText in die Zwischenablage geschrieben wird.

Üblicherweise bleibt nach dem Ausschneiden der Cursor an seiner Position stehen. Deshalb merken wir uns in der Variablen cursorPosition diese und setzen nach der Zeichenfolgemanipulation den Cursor wieder passend ein. Würden wir darauf verzichten, wäre der Cursor vor dem ersten Zeichen positioniert.

Das Ausschneiden des markierten Textes und das neuerliche Zusammensetzen der Restzeichenfolge erfolgt in der Methode Ausschneiden. Diese erwartet die Referenz auf die Textbox, aus der die markierte Teilzeichenfolge ausgeschnitten werden soll.

Das Einfügen eines Textes ist schon etwas aufwändiger. Wir müssen dabei zwei Dinge berücksichtigen:

Ist kein Text in der Textbox markiert, in die der Inhalt der Zwischenablage geschrieben werden soll, wird die Position des Cursors als Einfügeposition bewertet.

Sollte in der Textbox Text markiert sein, muss dieser durch den Inhalt der Zwischenablage ersetzt werden.

Nach dem Einfügen gilt es, die neue Zeichenfolge zu bilden und den Cursor an das Ende des eingefügten Textes zu setzen.

Markierter Text wird mit dem Menüelement Löschen ausgeschnitten, aber nicht der Zwischenablage übergeben. Die Cursorposition ist anschließend zwischen den beiden verbleibenden Teilstrings. Für das Ausschneiden hatten wir weiter oben eine gleichnamige Methode bereitgestellt.

Unabhängig davon, ob der Benutzer sich des Anwendungs- oder Kontextmenüs bedient, um den Inhalt einer Textbox zu verändern, die Funktionalitäten Ausschneiden, Kopieren, Löschen und Einfügen bleiben dieselben. Daher werden die Click-Ereignisse der Menüelemente des Kontextmenüs mit den entsprechenden Ereignishandlern des Anwendungsmenüs verknüpft.

Das Ereignis DropDownOpening wird ausgelöst, ehe das angeklickte Menüelement sein Untermenü öffnet. Wir nutzen dieses Ereignis des Menüpunktes Bearbeiten, um festzustellen, ob

sich einfügbarer Text in der Zwischenablage befindet. Wenn nicht, kann der Menüpunkt Einfügen deaktiviert werden.

in der aktiven Textbox kein Text markiert ist. In dem Fall gibt es nichts zu löschen, auszuschneiden oder in die Zwischenablage zu kopieren. Dann können die Menüpunkte Ausschneiden, Löschen und Kopieren deaktiviert angezeigt werden.

Diese Prüfungen vollzieht der Ereignishandler des DropDownOpening-Ereignisses.

Analog wird auch die Aktivierung der Menüelemente des Kontextmenüs gesteuert. Dazu dient uns das Ereignis Opening.

Kommen wir jetzt zum letzten Schritt. Im Kontextmenü wird ebenfalls die Änderung der Hintergrundfarbe angeboten. Wir müssen die Methode ChangeColor, die auch diesen Menüelementen als Ereignishandler dient, so ergänzen, dass eine Änderung der Farbe auch vom entsprechenden Kontextmenüelement verzeichnet wird.